Chore: Add agent description support in UI - #707
Conversation
🦋 Changeset detectedLatest commit: 52456e6 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
00210d3 to
77664b5
Compare
Resolve AgentsLibrary empty-page pagination vs table conflict, and keep agent descriptions in the searchAgents harness mock with pagination/filter. Co-authored-by: Cursor <cursoragent@cursor.com>
…ary for better handling of agent descriptions - Added 'description' field to agent records in agentStoreContractSuite, TrueFoundryMcpServerStore.test, and TrueFoundryModelProviderStore.test. - Updated AgentsLibrary component to improve description handling, ensuring proper truncation and avoiding name-echo descriptions. - Enhanced test cases to verify description truncation and visibility in the AgentsLibrary.
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 52456e6. Configure here.
| <aside className="flex min-h-0 min-w-0 flex-col gap-3 md:overflow-auto"> | ||
| {description ? ( | ||
| <AgentOverviewCard title="Description" icon="file"> | ||
| <p className="text-xs text-text-secondary">{description}</p> |
There was a problem hiding this comment.
Overview flattens multi-line descriptions
Low Severity
The save form accepts a multi-line description (textarea, up to 1024 characters), but the overview card renders it in a normal paragraph with no wrapping control. Line breaks the user entered are collapsed, and a long unbroken string can overflow the 18rem sidebar.
Reviewed by Cursor Bugbot for commit 52456e6. Configure here.
* Persist top-level agent description * fixes * Regenerate OpenAPI document and TypeScript SDK * migrations updated * Make description required * comment addressed * Regenerate OpenAPI document and TypeScript SDK * Chore: Add agent description support in UI (#707) * Regenerate OpenAPI document and TypeScript SDK * Chore: Add agent description support in UI * Enhancement: Implement support for agent descriptions across UI components * chore: update @truefoundry/assistant-ui-runtime to version 0.1.37 in package.json files * Refactor: Simplify agent description handling and improve UI consistency * Fix: Ensure agent description is displayed in the save dialog * Refactor: Replace description text with tooltip in AgentLibraryRow and remove unused description in AgentOverview * Enhancement: Add description display in AgentOverview component * Add description field to agent records in tests and update AgentsLibrary for better handling of agent descriptions - Added 'description' field to agent records in agentStoreContractSuite, TrueFoundryMcpServerStore.test, and TrueFoundryModelProviderStore.test. - Updated AgentsLibrary component to improve description handling, ensuring proper truncation and avoiding name-echo descriptions. - Enhanced test cases to verify description truncation and visibility in the AgentsLibrary. --------- Co-authored-by: trueforge-dev-bot[bot] <trueforge-dev-bot[bot]@users.noreply.github.com> Co-authored-by: Govinda Vashishtha <57435703+govindavashishtha@users.noreply.github.com> Co-authored-by: Cursor <cursoragent@cursor.com> Co-authored-by: Bhavesh Patel <bhavesh@truefoundry.com> --------- Co-authored-by: trueforge-dev-bot[bot] <trueforge-dev-bot[bot]@users.noreply.github.com> Co-authored-by: harshil-2096 <100749155+harshil-2096@users.noreply.github.com> Co-authored-by: Govinda Vashishtha <57435703+govindavashishtha@users.noreply.github.com> Co-authored-by: Cursor <cursoragent@cursor.com>


Summary
Changes
How was this tested?
Checklist
pnpm build,pnpm test,pnpm typecheck,pnpm lint:ci, andpnpm format:checkpass locallypackages/trueforge-sdk,.github/fern/openapi/openapi.json,docs/openapi.json) — fork PRs omit SDK regen; maintainers regenerate after merge.env.exampleupdated if configuration or behavior changedNote
Low Risk
UI and agent registry field plumbing with conservative update semantics; no auth or security-sensitive logic changed.
Overview
Adds agent description as metadata outside the executable
AgentSpec, wired through save/load and shown in the agents library and agent details overview.The save/update drawer now includes a required description field (1024 char max), prefilled when updating an existing agent and passed through
ShellModeContexton edit/clone. The TrueForge builder adapter sendsdescriptionon create (defaulting to the agent name when cloning legacy agents without one) and on update only when non-empty so drafts without description do not wipe stored values.The agents library shows a truncated subtitle with tooltip under each name (skipping when description equals the name), widens the name column, and preserves description on clone/edit. Agent details overview adds a Description card when present.
@truefoundry/assistant-ui-runtimeis bumped to 0.1.37 with matching test coverage.Reviewed by Cursor Bugbot for commit 52456e6. Bugbot is set up for automated code reviews on this repo. Configure here.